Получение информации о зоне

Получение информации о тарифах и дополнительных опциях в конкретной зоне.

Информация о зоне передается в виде координат в lat и lon. При невалидных координатах выдается ошибка "Zone not found".

Язык можно сменить параметром Accept-Language.

Синтаксис запроса

GET http://b2b-api.go.yandex.ru/integration/2.0/zoneinfo?lat=<широта>&lon=<долгота>

Заголовки запроса

  • Authorization: Bearer <OAuth-токен>
    Процесс получения токена описан в разделе Начало работы.
  • X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.
  • X-Request-Language: en

Параметры запроса

Запрос должен содержать следующие обязательные параметры:

  • lat — широта точки, принадлежащей зоне.

  • lon — долгота точки, принадлежащей зоне.

Описание полей ответа

В ответе содержатся поля:

Поле Описание Формат
timezone_offset Часовой пояс (смещение). Пример: "+0300". Строка
max_route_points_count Максимальное количество точек маршрута. Число
country_code Код страны. Пример: "RU". Строка
currency_code Код валюты. Пример: "RUB". Строка
tariff_classes Массив тарифов. Массив
timezone Часовой пояс (название). Пример: "Europe/Moscow". Строка
default_tariff_class Тариф по умолчанию. Строка
client_cache_settings Опции клиента, сохраненные в кеше. JSON с названиями и значениями опций. Объект
combo_orders_info Данные по комбинированным заказам. Объект

Структура элемента массива tariff_classes:

Поле Описание Формат
name Нззвание тарифа (латинскими буквами). Строка
name_translate Название тарифа. Строка
supported_requirements Массив требований. Массив объектов
icon Ссылка на значок тарифного класса. Объект
image Ссылка на изображение тарифного класса. Объект
max_route_points_count Максимальное количество точек маршрута. Число
has_extra_contact_phone Наличие дополнительного номера телефона. Булево
req_destination Обязательность указания точки назначения. Булево

Структура элемента "ссылка":

Поле Описание Формат
url Ссылка на изображение. Строка
size_hint Максимальный размер файла с изображением. Число
image_tag Тег изображения. Строка
url_parts Объект, состоящий из ключа key и части URL после адреса сервера path. Объект

Структура элемента массива supported_requirements:

Поле Описание Формат
name Нззвание требования (латинскими буквами). Строка
label Название требования. Строка
glued Применяется к пожеланиям типа select в тарифах. Если равно true,то пожелание прикрепляется к верхней части карточки саммари и становится обязательным для выбора перед созданием заказа. Локально блокируется кнопка Заказать, пока пользователь не выберет значение. Поле не обязательно для заполнения, если задано optional_glued: true. Булево
type Тип требования. Возможные значения: select, boolean. Строка
multiselect Используется для пожеланий в тарифах, где требуется множественный выбор. Если значение равно true, пользователь может выбрать несколько опций из списка. Также задает ограничение на максимальный вес выбранных опций (max_weight) и количество выбранных опций (max_count). Булево
max_weight Максимальный суммарный вес выбранных опций. Используется для ограничения выбора, если опции имеют вес. Например, для детских кресел:
- Кресло "infant" может иметь вес 2.
- Кресло "chair" может иметь вес 2.
- Бустер "booster" может иметь вес 1.
Суммарный вес выбранных опций не должен превышать значение max_weight.		 Число
select Описание требования. Указывается только для требований с типом select. Объект

Структура объекта select:

Поле Описание Формат
options Нззвание требования (латинскими буквами). Массив объектов
type Тип значения. Строка

Структура элемента массива options:

Поле Описание Формат
name Нззвание опции (латинскими буквами). Массив объектов
label Название требования, к которому относится опция. Строка
title Название опции. Строка
weight Вес. Число
max_count Максимальное количество опций, которые можно выбрать. Применяется, когда нужно ограничить число выбранных элементов, независимо от их веса. Число
value Значение опции. Число

Структура объекта combo_orders_info:

Поле Описание Формат
allowed_vehicle_capacities Разрешенные количества пассажиров. Массив чисел
preselected_vehicle_capacity Количество пассаржиров по умолчанию. Число

Пример запроса

GET http://b2b-api.go.yandex.ru/integration/2.0/zoneinfo?lat=32.093320&lon=34.798363
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "timezone_offset": "+0300",
  "max_route_points_count": 5,
  "country_code": "RU",
  "currency_code": "RUB",
  "tariff_classes": [
    {
      "name": "maybach",
      "name_translate": "Élite",
      "supported_requirements": [
        {
          "name": "door_to_door",
          "label": "От двери до двери",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "dont_open_door",
          "label": "Открою дверь сам",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "quiet_ride",
          "label": "Поездка в тишине",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "best_drivers",
          "label": "Водители с высоким рейтингом",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "childchair_v2",
          "label": "Детское кресло",
          "glued": false,
          "type": "select",
          "multiselect": true,
          "max_weight": 2.0,
          "select": {
            "options": [
              {
                "name": "infant",
                "label": "9–18 кг",
                "title": "Кресло, от 9 мес. до 4 лет",
                "weight": 1.0,
                "max_count": 2,
                "value": 1
              },
              {
                "name": "chair",
                "label": "15–25 кг",
                "title": "Кресло, 3–7 лет",
                "weight": 1.0,
                "max_count": 2,
                "value": 3
              },
              {
                "name": "booster",
                "label": "22–36 кг",
                "title": "Бустер, 6–12 лет",
                "weight": 1.0,
                "max_count": 2,
                "value": 7
              }
            ],
            "type": "number"
          }
        },
        {
          "name": "move_things",
          "label": "Донести вещи, проводить",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "small_dog_animaltransport",
          "label": "Небольшая собака (до 10 кг)",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "big_dog_animaltransport",
          "label": "Крупная собака (от 10 кг)",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "cat_animaltransport",
          "label": "Кошка",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "other_animaltransport",
          "label": "Другое животное",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "transfer",
          "label": "Встреча в аэропорту",
          "glued": false,
          "type": "select",
          "multiselect": false,
          "select": {
            "options": [
              {
                "name": "with_sign",
                "label": "С табличкой",
                "title": "С табличкой",
                "value": 2
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/c1ff75cc-3694-4cd6-b685-39aa001bd519",
        "size_hint": 9999,
        "image_tag": "class_maybach_icon_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/c1ff75cc-3694-4cd6-b685-39aa001bd519"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/d7b2729525e642609a1d19c93553768e",
        "size_hint": 9999,
        "image_tag": "class_maybach_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/d7b2729525e642609a1d19c93553768e"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "lite_b2b",
      "name_translate": "Лайт",
      "supported_requirements": [
        {
          "name": "transfer",
          "label": "Встреча в аэропорту",
          "glued": false,
          "type": "select",
          "multiselect": false,
          "select": {
            "options": [
              {
                "name": "with_sign",
                "label": "С табличкой",
                "title": "С табличкой",
                "value": 2
              },
              {
                "name": "no_sign",
                "label": "Без таблички",
                "title": "Без таблички",
                "value": 1
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/2426cf67de314daeb6add3223897455e",
        "size_hint": 9999,
        "image_tag": "class_lite_b2b_icon_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/2426cf67de314daeb6add3223897455e"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/3ee2a298d16c4a399deb29eb0f20b7a3",
        "size_hint": 9999,
        "image_tag": "class_lite_b2b_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/3ee2a298d16c4a399deb29eb0f20b7a3"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "standart_b2b",
      "name_translate": "Стандарт",
      "supported_requirements": [
        {
          "name": "transfer",
          "label": "Встреча в аэропорту",
          "glued": false,
          "type": "select",
          "multiselect": false,
          "select": {
            "options": [
              {
                "name": "with_sign",
                "label": "С табличкой",
                "title": "С табличкой",
                "value": 2
              },
              {
                "name": "no_sign",
                "label": "Без таблички",
                "title": "Без таблички",
                "value": 1
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/598/edad66067be54c77b4606e9fb62d5691",
        "size_hint": 9999,
        "image_tag": "class_standart_b2b_icon_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/598/edad66067be54c77b4606e9fb62d5691"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/598/e983cd9ff0e14404aa4c6e1124fd561e",
        "size_hint": 9999,
        "image_tag": "class_standart_b2b_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/598/e983cd9ff0e14404aa4c6e1124fd561e"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "optimum_b2b",
      "name_translate": "Оптимум",
      "supported_requirements": [
        {
          "name": "transfer",
          "label": "Встреча в аэропорту",
          "glued": false,
          "type": "select",
          "multiselect": false,
          "select": {
            "options": [
              {
                "name": "with_sign",
                "label": "С табличкой",
                "title": "С табличкой",
                "value": 2
              },
              {
                "name": "no_sign",
                "label": "Без таблички",
                "title": "Без таблички",
                "value": 1
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/743/6f20f9fa000b4e178999bd7813094256",
        "size_hint": 9999,
        "image_tag": "class_optimum_b2b_icon_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/743/6f20f9fa000b4e178999bd7813094256"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/598/3e3afbb7c6ba4fce9589b015a78587f1",
        "size_hint": 9999,
        "image_tag": "class_optimum_b2b_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/598/3e3afbb7c6ba4fce9589b015a78587f1"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "child_tariff",
      "name_translate": "Детский",
      "supported_requirements": [
        {
          "name": "nosmoking",
          "label": "Некурящий водитель",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "childchair_v2",
          "label": "Детское кресло",
          "glued": true,
          "type": "select",
          "multiselect": true,
          "max_weight": 2.0,
          "select": {
            "options": [
              {
                "name": "own_chair",
                "label": " ",
                "title": "Своё кресло",
                "weight": 1.0,
                "max_count": 1,
                "value": 10
              },
              {
                "name": "bassinet",
                "label": "До 13 кг",
                "title": "Люлька, до 1 года",
                "weight": 2.0,
                "max_count": 1,
                "value": 11
              },
              {
                "name": "infant",
                "label": "9–18 кг",
                "title": "Кресло, от 9 мес. до 4 лет",
                "weight": 1.0,
                "max_count": 2,
                "value": 1
              },
              {
                "name": "chair",
                "label": "15–25 кг",
                "title": "Кресло, 3–7 лет",
                "weight": 1.0,
                "max_count": 2,
                "value": 3
              },
              {
                "name": "booster",
                "label": "22–36 кг",
                "title": "Бустер, 6–12 лет",
                "weight": 1.0,
                "max_count": 2,
                "value": 7
              }
            ],
            "type": "number"
          }
        },
        {
          "name": "bicycle_other",
          "label": "Велосипед",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "move_things",
          "label": "Донести вещи, проводить",
          "glued": false,
          "type": "boolean"
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/598/068b87a6f82a457cb6b433e3e8820836",
        "size_hint": 9999,
        "image_tag": "class_child_tariff_icon_7_child_tariff",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/598/068b87a6f82a457cb6b433e3e8820836"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/743/88863bf078f24a22bc04f8e274111580",
        "size_hint": 9999,
        "image_tag": "class_child_tariff_car_7_child_tariff",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/743/88863bf078f24a22bc04f8e274111580"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "ultimate",
      "name_translate": "Premier",
      "supported_requirements": [
        {
          "name": "animaltransport",
          "label": "Перевозка домашнего животного",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "animaltransport",
          "label": "Перевозка домашнего животного",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "dont_open_door",
          "label": "Открою дверь сам",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "quiet_ride",
          "label": "Поездка в тишине",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "childchair_v2",
          "label": "Детское кресло",
          "glued": true,
          "type": "select",
          "multiselect": true,
          "max_weight": 3.0,
          "select": {
            "options": [
              {
                "name": "infant",
                "label": "9–18 кг",
                "title": "Кресло, от 9 мес. до 4 лет",
                "weight": 2.0,
                "max_count": 1,
                "value": 1
              },
              {
                "name": "chair",
                "label": "15–25 кг",
                "title": "Кресло, 3–7 лет",
                "weight": 2.0,
                "max_count": 1,
                "value": 3
              },
              {
                "name": "booster",
                "label": "22–36 кг",
                "title": "Бустер, 6–12 лет",
                "weight": 2.0,
                "max_count": 1,
                "value": 7
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/3c459ceb-ffa3-40b5-9e86-1aa6c47c9e57",
        "size_hint": 9999,
        "image_tag": "class_ultimate_icon_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/3c459ceb-ffa3-40b5-9e86-1aa6c47c9e57"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/743/d9550ffe029c4dfcbb68b8f1a00039ea",
        "size_hint": 9999,
        "image_tag": "class_ultimate_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/743/d9550ffe029c4dfcbb68b8f1a00039ea"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "minivan",
      "name_translate": "Минивэн",
      "supported_requirements": [
        {
          "name": "animaltransport",
          "label": "Перевозка домашнего животного",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "bicycle",
          "label": "Велосипед",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "ski",
          "label": "Лыжи или сноуборд",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "big_minivan",
          "label": "Донести вещи",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "childchair_v2",
          "label": "Детское кресло",
          "glued": false,
          "type": "select",
          "multiselect": true,
          "max_weight": 3.0,
          "select": {
            "options": [
              {
                "name": "infant",
                "label": "9–18 кг",
                "title": "Кресло, от 9 мес. до 4 лет",
                "weight": 2.0,
                "max_count": 1,
                "value": 1
              },
              {
                "name": "chair",
                "label": "15–25 кг",
                "title": "Кресло, 3–7 лет",
                "weight": 2.0,
                "max_count": 1,
                "value": 3
              },
              {
                "name": "booster",
                "label": "22–36 кг",
                "title": "Бустер, 6–12 лет",
                "weight": 2.0,
                "max_count": 1,
                "value": 7
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/743/8c618970936d434a8759543ed3d4cbb0",
        "size_hint": 9999,
        "image_tag": "class_minivan_icon_7_help_nearby",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/743/8c618970936d434a8759543ed3d4cbb0"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/fb410994120f424289661db21ad431d9",
        "size_hint": 9999,
        "image_tag": "class_minivan_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/fb410994120f424289661db21ad431d9"
        }
      },
      "max_route_points_count": 5,
      "has_extra_contact_phone": false,
      "req_destination": false
    },
    {
      "name": "vip",
      "name_translate": "Business",
      "supported_requirements": [
        {
          "name": "has_conditioner",
          "label": "Кондиционер",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "dont_open_door",
          "label": "Открою дверь сам",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "animaltransport",
          "label": "Перевозка домашнего животного",
          "glued": false,
          "type": "boolean"
        },
        {
          "name": "childchair_v2",
          "label": "Детское кресло",
          "glued": false,
          "type": "select",
          "multiselect": true,
          "max_weight": 5.0,
          "select": {
            "options": [
              {
                "name": "infant",
                "label": "9–18 кг",
                "title": "Кресло, от 9 мес. до 4 лет",
                "weight": 3.0,
                "max_count": 1,
                "value": 1
              },
              {
                "name": "chair",
                "label": "15–25 кг",
                "title": "Кресло, 3–7 лет",
                "weight": 3.0,
                "max_count": 1,
                "value": 3
              },
              {
                "name": "booster",
                "label": "22–36 кг",
                "title": "Бустер, 6–12 лет",
                "weight": 2.0,
                "max_count": 2,
                "value": 7
              }
            ],
            "type": "number"
          }
        },
        {
          "name": "transfer",
          "label": "Встреча в аэропорту",
          "glued": false,
          "type": "select",
          "multiselect": false,
          "select": {
            "options": [
              {
                "name": "with_sign",
                "label": "С табличкой",
                "title": "С табличкой",
                "value": 2
              }
            ],
            "type": "number"
          }
        }
      ],
      "icon": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/743/f9a50577-63e5-4d39-98c6-69a992b83906",
        "size_hint": 9999,
        "image_tag": "class_vip_icon_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/743/f9a50577-63e5-4d39-98c6-69a992b83906"
        }
      },
      "image": {
        "url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/31a482900a184aa6acb6991c43a62d29",
        "size_hint": 9999,
        "image_tag": "class_vip_car_7",
        "url_parts": {
          "key": "TC",
          "path": "/static/test-images/1138/31a482900a184aa6acb6991c43a62d29"
        }
      },
      "max_route_points_count": 6,
      "has_extra_contact_phone": false,
      "req_destination": false
    }
  ],
  "timezone": "Europe/Moscow",
  "default_tariff_class": "maybach",
  "client_cache_settings": {
    "zones_max_count": 5,
    "zone_ttl_sec": 864000
  },
  "combo_orders_info": {
    "allowed_vehicle_capacities": [
      3,
      4,
      6
    ],
    "preselected_vehicle_capacity": 4
  }
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 400 — в запросе был передан неизвестный параметр или параметр с недопустимым значением.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.
    • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
    • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
  • 404 — зона не найдена, проблема на стороне клиента.
Предыдущая
Удаление района
Следующая
Создание серии промокодов